feat(vector-search): migrate to databricks-ai-search SDK, add filtering reference#197
Open
jiayi-wu-3150 wants to merge 1 commit into
Open
Conversation
…ng reference
Replace deprecated databricks-sdk WorkspaceClient vector_search_* APIs and
databricks-vectorsearch VectorSearchClient with the current AISearchClient
from databricks-ai-search across all skill files.
Key changes:
- SKILL.md: AISearchClient flat-param API, unified filters= parameter, add
Installation section and filtering.md reference
- references/index-types.md: flat create_delta_sync_index/create_direct_access_index,
index.upsert(list)/index.delete(primary_keys) instead of inputs_json/schema_json
- references/search-modes.md: index.similarity_search(), lowercase query_type
values ("hybrid" not "HYBRID"), drop filters_json, add DatabricksReranker section
- references/troubleshooting-and-operations.md: client.get_endpoint/get_index,
index.sync/describe, add Performance & Capacity section with SLA targets and
debug_level guidance
- references/filtering.md: new file with full operator reference for both
Standard (dict) and Storage-Optimized (SQL string) filter syntax
Co-authored-by: Isaac
jiayi-wu-3150
requested review from
lennartkats-db and
simonfaltum
as code owners
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
WorkspaceClient.vector_search_*/VectorSearchClientAPIs toAISearchClientfrom thedatabricks-ai-searchpackage (SDK migration reference)references/filtering.md— new comprehensive filter operator reference for both Standard (dict syntax) and Storage-Optimized (SQL string syntax) endpointsDatabricksRerankersection tosearch-modes.md(~10% quality gain, ~1.5s overhead)troubleshooting-and-operations.mdwith SLA targets, sizing guidance, OAuth vs PAT performance, anddebug_level=1latency breakdownFiles changed
SKILL.mdfilters=parameter; Installation section;filtering.mdreference addedreferences/index-types.mdcreate_delta_sync_index/create_direct_access_indexflat params;index.upsert(list)/index.delete(primary_keys)replacinginputs_json/schema_jsonreferences/search-modes.mdindex.similarity_search(); lowercasequery_typevalues ("hybrid"not"HYBRID");filters_jsonremoved;DatabricksRerankersection addedreferences/troubleshooting-and-operations.mdclient.get_endpoint/get_index,index.sync/describe; Performance & Capacity section; 429 error row addedreferences/filtering.mdNotes
databricks vector-search-endpoints,databricks vector-search-indexes) are unchanged — official CLI docs have not been updated yetreferences/end-to-end-rag.mdis not changed in this PR (CLI convention question pending)databricks-vector-search→databricks-ai-search) is intentionally excluded — that requiresmetaplugin/plugin.meta.jsonupdates and manifest regeneration, and will be filed as a separate PRTest plan
AISearchClientimport and flat-param API against official docsindex.similarity_search()parameters against official docsDatabricksRerankerusage against official query docsThis pull request and its description were written by Isaac.